'\" te
.\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1999, Sun Microsystems, Inc.  All Rights Reserved
.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
.TH GETCH 3XCURSES "Jun 5, 2002"
.SH NAME
getch, wgetch, mvgetch, mvwgetch \- get a single-byte character from the
terminal
.SH SYNOPSIS
.LP
.nf
\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e
\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ]

\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ]

#include <curses.h>

\fBint\fR \fBgetch\fR(\fBvoid\fR);
.fi

.LP
.nf
\fBint\fR \fBwgetch\fR(\fBWINDOW *\fR\fIwin\fR);
.fi

.LP
.nf
\fBint\fR \fBmvgetch\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR);
.fi

.LP
.nf
\fBint\fR \fBmvwgetch\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR);
.fi

.SH PARAMETERS
.sp
.ne 2
.na
\fB\fIwin\fR\fR
.ad
.RS 7n
Is a pointer to the window associated with the terminal from which the
character is to be read.
.RE

.sp
.ne 2
.na
\fB\fIy\fR\fR
.ad
.RS 7n
Is the y (row) coordinate for the position of the character to be read.
.RE

.sp
.ne 2
.na
\fB\fIx\fR\fR
.ad
.RS 7n
Is the x (column) coordinate for the position of the character to be read.
.RE

.SH DESCRIPTION
.sp
.LP
These functions read a single-byte character from the terminal associated with
the current or specified window. The results are unspecified if the input is
not a single-byte character. If \fBkeypad\fR(3XCURSES) is enabled, these
functions respond to the pressing of a function key by returning the
corresponding \fBKEY_\fR value defined in <\fBcurses.h\fR>
.sp
.LP
Processing of terminal input is subject to the general rules described on the
\fBkeypad\fR(3XCURSES) manual page.
.sp
.LP
If echoing is enabled, then the character is echoed as though it were provided
as an input argument to \fBaddch\fR(3XCURSES), except for the following
characters:
.sp
.ne 2
.na
\fB<backspace>\fR
.ad
.RS 17n
The input is interpreted as follows: unless the cursor already was in column 0,
<backspace> moves the cursor one column toward the start of the current line
and any characters after the <backspace> are added or inserted starting there.
The character at the resulting cursor position it then deleted as though
\fBdelch\fR(3XCURSES) were called, except that if the cursor was originally in
the first column of the line, the user is alerted as though
\fBbeep\fR(3XCURSES) were called.
.RE

.sp
.ne 2
.na
\fBFunction keys\fR
.ad
.RS 17n
The user is alerted  as though \fBbeep()\fR were called. Information concerning
the function keys is not returned to the caller.
.RE

.sp
.LP
If the current or specified window is not a pad, and it has been moved modified
since the last refresh operation, then it will be refreshed before another
character is read.
.SS "Constant Values for Function Keys"
.sp
.LP
The following is a list of tokens for function keys that are returned by  the
\fBgetch()\fR set of functions if keypad handling is enabled (some  terminals
may not support all tokens).
.sp

.sp
.TS
box;
c c
l l .
\fBConstant\fR	\fBDescription\fR
_
KEY_BREAK	Break key
KEY_DOWN	The down arrow key
KEY_UP	The up arrow key
KEY_LEFT	The left arrow key
KEY_RIGHT	The right arrow key
KEY_HOME	Home key
KEY_BACKSPACE	Backspace
KEY_F0	T{
Function keys.  Space for 64 keys is reserved.
T}
KEY_F(\fIn\fR)	For  0 <= \fIn\fR <= 63
KEY_DL	Delete line
KEY_IL	Insert line
KEY_DC	Delete character
KEY_IC	Insert char or enter insert mode
KEY_EIC	Exit insert char mode
KEY_CLEAR	Clear screen
KEY_EOS	Clear to end of screen
KEY_EOL	Clear to end of line
KEY_SF	Scroll 1 line forward
 KEY_SR	Scroll 1 line backwards
KEY_NPAGE	Next page
KEY_PPAGE	Previous page
KEY_STAB	Set tab
KEY_CTAB	Clear tab
KEY_CATAB	Clear all tabs
KEY_ENTER	Enter or send
KEY_SRESET	Soft (partial) reset
KEY_RESET	Reset or hard reset
KEY_PRINT	Print or copy
KEY_LL	Home down or bottom (lower left)
KEY_A1	Upper left of keypad
KEY_A3	Upper right of keypad
KEY_B2	Center of keypad
KEY_C1	Lower left of keypad
KEY_C3	Lower right of keypad
KEY_BTAB	Back tab
KEY_BEG	Beginning key
KEY_CANCEL	Cancel key
KEY_CLOSE	Close key
KEY_COMMAND	Cmd (command) key
KEY_COPY	Copy key
KEY_CREATE	Create key
KEY_END	End key
KEY_EXIT	Exit key
KEY_FIND	Find key
KEY_HELP	Help key
KEY_MARK	Mark key
KEY_MESSAGE	Message key
KEY_MOVE	Move key
KEY_NEXT	Next object key
KEY_OPEN	Open key
KEY_OPTIONS	Options key
KEY_PREVIOUS	Previous object key
KEY_REDO	Redo key
KEY_REFERENCE	Reference key
KEY_REFRESH	Refresh key
KEY_REPLACE	Replace key
KEY_RESTART	Restart key
KEY_RESUME	Resume key
KEY_SAVE	Save key
KEY_SBEG	Shifted beginning key
KEY_SCANCEL	Shifted cancel key
KEY_SCOMMAND	Shifted command key
KEY_SCOPY	Shifted copy key
KEY_SCREATE	Shifted create key
KEY_SDC	Shifted delete char key
KEY_SDL	Shifted delete line key
KEY_SELECT	Select key
KEY_SEND	Shifted end key
KEY_SEOL	Shifted clear line key
KEY_SEXIT	Shifted exit key
KEY_SFIND	Shifted find key
KEY_SHELP	Shifted help key
KEY_SHOME	Shifted home key
KEY_SIC	Shifted input key
KEY_SLEFT 	Shifted left arrow key
KEY_SMESSAGES	Shifted messages key
KEY_SMOVE	Shifted move key
KEY_SNEXT	Shifted next key
KEY_SOPTIONS	Shifted options key
KEY_SPREVIOUS	Shifted previous key
KEY_SPRINT	Shifted print key
KEY_SREDO	Shifted redo key
KEY_SREPLACE	Shifted replace key
KEY_SRIGHT	Shifted right arrow key
KEY_SRSUME	Shifted resume key
KEY_SSAVE	Shifted save key
KEY_SSUSPEND	Shifted suspend key
KEY_SUNDO	Shifted undo key
KEY_SUSPEND	Suspend key
KEY_UNDO	Undo key
.TE

.SH RETURN VALUES
.sp
.LP
Upon successful completion, these functions return the single-byte character,
\fBKEY_\fR value, or \fBERR\fR. When in the nodelay mode and no data is
available, \fBERR\fR is returned.
.SH ERRORS
.sp
.LP
No errors are defined.
.SH  USAGE
.sp
.LP
Applications should not define the escape key by itself as a single-character
function.
.sp
.LP
When using these functions, nocbreak mode (\fBcbreak\fR(3XCURSES)) and echo
mode (\fBecho\fR(3XCURSES)) should not be used at the same time. Depending on
the state of the terminal when each character is typed, the application may
produce undesirable results.
.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(7) for descriptions of the following attributes:
.sp

.sp
.TS
box;
c | c
l | l .
ATTRIBUTE TYPE	ATTRIBUTE VALUE
_
Interface Stability	Standard
_
MT-Level	Unsafe
.TE

.SH SEE ALSO
.sp
.LP
.BR cbreak (3XCURSES),
.BR echo (3XCURSES),
.BR halfdelay (3XCURSES),
.BR keypad (3XCURSES),
.BR libcurses (3XCURSES),
.BR nodelay (3XCURSES),
.BR notimeout (3XCURSES),
.BR raw (3XCURSES),
.BR timeout (3XCURSES),
.BR attributes (7),
.BR standards (7)
